home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / guis für programme / soxgui12 / soxgui.doc < prev    next >
Text File  |  1996-04-07  |  6KB  |  156 lines
  1. SoxGui 1.2
  2.  
  3. Contents:
  4.                                                                     line
  5.    Legal Notes .....................................................  17
  6.    About SoxGui ....................................................  31
  7.    System Requirements .............................................  44
  8.    Installation ....................................................  52
  9.    How to use it ...................................................  80
  10.    Limitation ...................................................... 108
  11.    Technical Note .................................................. 115
  12.    Future Versions ................................................. 132
  13.    Closing Note .................................................... 139
  14.    Authors Adress .................................................. 146
  15.  
  16.  
  17. Legal Notes:
  18.  
  19. The programs and files in this distribution are freely distributable.
  20. It may not be sold in any form, though a reasonable  copying and  handling 
  21. charge is acceptable, as long as the complete SoxGui distribution is
  22. included.
  23. No commercial usage is permitted without written permission from the
  24. author.
  25. This software and manual file are offered "as is" and without warranties as
  26. to performance or merchantability. Any statments made about the uses of
  27. this software do not constitute warranties and shall not be relied on by
  28. the user of this program.
  29.  
  30.  
  31. About SoxGui:
  32.  
  33. Probably you know the sample converting utility Sox. This program , ported
  34. from UNIX to the Amiga and named AmiSox is available in the AmiNet. It's a
  35. powerful tool, able to convert many sampleformats and allowing you to apply
  36. some effects and filters to your samples. Its great disadvantage is the
  37. UNIX-like commandline usage, which makes it difficult to use. This is where
  38. SoxGui 1.2 enters the scene. SoxGui is a graphical user interface for Sox
  39. that allows the unexperienced or simply lazy user to access (almost) any
  40. features and functions of AmiSox just by clicking with the mouse. SoxGui
  41. was written for use with AmiSox 3.3
  42.  
  43.  
  44. System Requirements:
  45.  
  46. Any Amiga should suffice although I have only tested it with my A4000/30
  47. with 10MB of RAM. AmiSox is _not_ included in this package though you
  48. _definitly_ need it to use this program. You should find it in the AmiNet,
  49. in public domain and on any FTP-site which supports Amiga software.
  50.  
  51.  
  52. Installation:
  53.  
  54. Just copy the executable file to any drawer by dragging it with the mouse.
  55. If you're still using KickStart 1.3 arp.library has to be present in your
  56. Libs:-drawer. In addition to that the stack should be assigned a size of
  57. 5000 or more. After that SoxGui has to be told using the icon's ToolTypes,
  58. where the executable file is located. If you want to listen to the results
  59. of using AmiSox you can also assign an external player , which is then
  60. executed by SoxGui. This player is called using <player_name> <sample_name>
  61. - make shure your player is called that way. I prefer DSound for this
  62. purpose, it works just fine.
  63.  
  64. There are two possible entries for the ToolTypes:
  65.  
  66. - SOXPATH=<path to Sox-executable>
  67.           where path is the complete path including the program's name.
  68.           Quotes are not allowed here !
  69.           Example: Work:Sound/Tools/Sox
  70.  
  71. - PLAYERPATH=<path to your sample-player> [parameters for your player]
  72.           where path is the complete path (see above)
  73.           Examples:  C:Play
  74.                  or  Work:Sound/DSound31/DSound -f -2 (which is my setting)
  75.  
  76. If started from shell or no ToolTypes parameters set, the program will
  77. look for "Sox" and "Play" in the current drawer and in C:.
  78.  
  79.  
  80. How to use it:
  81.  
  82. This section only describes the usage of SoxGui, please consult the
  83. documentation for AmiSox if you have any questions concerning that program.
  84. SoxGui opens a window on the workbench which is divided into three parts:
  85.  
  86. - files to work on:
  87.   This is where the In- and Outputfiles are named. Click on the name you
  88.   want to change and a filerequester opens, where you can specify the
  89.   desired files. If you want either the input- or the output- or both
  90.   samplefiles to be played you can switch on the button for each file.
  91.  
  92. - assignable effects:
  93.   Here you can choose one effect per use of AmiSox to be applied to your
  94.   sample, additional to the conversion. If you want to use more than one
  95.   effect you have to apply them by using AmiSox several times. To transmit
  96.   additional parameters for the effects just choose them by using the
  97.   sliders. Please note that some parameters that are normally - using the
  98.   shell - written as values between 0 and 1 have to be entered as
  99.   percentage values.
  100.  
  101. - actions
  102.   To start the conversion just click the button named "AMISOX !!!". The
  103.   output that is made by AmiSox is redirected to a shell-window. After
  104.   successful conversion this window is closed again. To exit SoxGui simply
  105.   close the SoxGui window. There is no onlinehelp available at the moment.
  106.  
  107.  
  108. Limitations:
  109.  
  110. SoxGui does not check the information that you enter. Everything is given
  111. directly to AmiSox. There is no possible way to interrogate if AmiSox
  112. worked correctly, too.
  113.  
  114.  
  115. Technical Note:
  116.  
  117. SoxGui was written and compiled with the extraordinary Basic-Compiler Ace
  118. 2.35 written by David Benn. Because some OS-functions - for example
  119. radio-buttons and toggle-select gadget - are not supported yet, I had to
  120. program some tricky parts to achive the desired effects. As a sad
  121. sideeffect the program is perhaps a bit slow. Using a 68000-Amiga the
  122. redraw procedure for the window in use will be veeeery slow which has no
  123. influence on the execution speed of AmiSox.
  124. The ToolTypes are being read with the subroutines from "WBarg" from David
  125. Benn.
  126. This documentation and the program itself were written using GoldEd
  127. written by Dietmar Eilert.
  128. If you like to, read the sourcecode although it is not the height of
  129. programming art. For sure there are parts that can be optimized.
  130.  
  131.  
  132. Future Versions:
  133.  
  134. If I'll be motivated once again, I will write an additional routine that
  135. will allow you to apply more than one effect every time you start AmiSox.
  136. Also, as stated before, the onlinehelp is missing.
  137.  
  138.  
  139. Closing Notes:
  140.  
  141. This program was written on one weekend and  the motivation was to test
  142. the features that come with Ace. If this program is useful for you please
  143. let me know. I am thankful for any hints, suggestions and small donations.
  144.  
  145.  
  146. Authors Adress:
  147.  
  148.         Stephan Klein
  149.         Ewaldstr. 71
  150.         45739 Oer-Erkenschwick
  151.         Germany
  152.  
  153. Have fun
  154.     Stephan ;-)
  155.  
  156.